Class PhysicalObjectImpl

java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.ui.impl.PhysicalObjectImpl
All Implemented Interfaces:
IPCObject, PhysicalObject

public class PhysicalObjectImpl extends IPCObjectImpl implements PhysicalObject
Information provided by the PKI file:

    \class PhysicalObject
    
    \brief An object in the Physical Workspace.
    
    \example appWindow().getActiveWorkspace().getRootPhysicalObject()
    
Author:
Auto-generated
  • Constructor Details

  • Method Details

    • getName

      public String getName()
      Information provided by the PKI file:
      
          \brief Returns the name of this physical object
          
          \return QString, name of the object.
          
              
      Specified by:
      getName in interface PhysicalObject
      Returns:
      String Returns a String
    • getType

      public PhysicalObjectType getType()
      Information provided by the PKI file:
      
          \brief Returns the type of physical object.
          INTER_CITY = 0,
          CITY = 1,
          BUILDING = 2,
          WIRING_CLOSET = 3,
          RACK = 4,
          TABLE = 5,
          DEVICE = 6
          MULTIUSER = 7,
          GENERIC_CONTAINER = 8,
          
          \return PhysicalObjectType
          
              
      Specified by:
      getType in interface PhysicalObject
      Returns:
      PhysicalObjectType Returns a PhysicalObjectType
    • getX

      public int getX()
      Information provided by the PKI file:
      
          \brief Returns X coordinate.
          
          \return int, x coordinate.
          
              
      Specified by:
      getX in interface PhysicalObject
      Returns:
      int Returns a int
    • getY

      public int getY()
      Information provided by the PKI file:
      
          \brief Returns Y coordinate.
          
          \return int, y coordinate.
          
              
      Specified by:
      getY in interface PhysicalObject
      Returns:
      int Returns a int
    • getCenterX

      public int getCenterX()
      Information provided by the PKI file:
      
          \brief Returns center X coordinate.
          
          \return int, center x coordinate.
          
              
      Specified by:
      getCenterX in interface PhysicalObject
      Returns:
      int Returns a int
    • getCenterY

      public int getCenterY()
      Information provided by the PKI file:
      
          \brief Returns center Y coordinate.
          
          \return int, center Y coordinate.
          
              
      Specified by:
      getCenterY in interface PhysicalObject
      Returns:
      int Returns a int
    • getGlobalX

      public double getGlobalX()
      Information provided by the PKI file:
      
          \brief Returns global X coordinate.
          
          \return double, global x coordinate.
          
              
      Specified by:
      getGlobalX in interface PhysicalObject
      Returns:
      double Returns a double
    • getGlobalY

      public double getGlobalY()
      Information provided by the PKI file:
      
          \brief Returns global Y coordinate.
          
          \return double, global Y coordinate.
          
              
      Specified by:
      getGlobalY in interface PhysicalObject
      Returns:
      double Returns a double
    • getDevice

      public Device getDevice()
      Information provided by the PKI file:
      
          \brief Returns the device if the type is DEVICE
          
          \return Device, the device in the object type is DEVICE.
          
              
      Specified by:
      getDevice in interface PhysicalObject
      Returns:
      Device Returns a Device
    • getParent

      public PhysicalObject getParent()
      Information provided by the PKI file:
      
          \brief Returns the parent that contains the physical object.
          
          \return PhysicalObject, the parent that contains the physical object.
          
              
      Specified by:
      getParent in interface PhysicalObject
      Returns:
      PhysicalObject Returns a PhysicalObject
    • moveOutOfCurrentObject

      public boolean moveOutOfCurrentObject()
      Information provided by the PKI file:
      
          \brief Moves the physical object out of the current parent object and returns whether it was successful.
          
          \return boolean, whether the move was successful.
          
              
      Specified by:
      moveOutOfCurrentObject in interface PhysicalObject
      Returns:
      boolean Returns a boolean
    • moveIntoObject

      public boolean moveIntoObject(String name)
      Information provided by the PKI file:
      
          \brief Moves the physical object into an object in the same level with the specified name and returns whether it was successful.
          
          \param name, the name of the object in the same level
          \return boolean, whether the move was successful.
          
              
      Specified by:
      moveIntoObject in interface PhysicalObject
      Parameters:
      name - Takes in a parameter of name
      Returns:
      boolean Returns a boolean
    • getChildCount

      public int getChildCount()
      Information provided by the PKI file:
      
          \brief Returns the number of children the physical object has.
          
          \return int, the number of children the physical object has.
          
              
      Specified by:
      getChildCount in interface PhysicalObject
      Returns:
      int Returns a int
    • getChildAt

      public PhysicalObject getChildAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the child at the given index in the physical object.
          
          \param index, index to get a child from.
          
          \return PhysicalObject, the child at the given index, if any.
          
              
      Specified by:
      getChildAt in interface PhysicalObject
      Parameters:
      index - Takes in a parameter of index
      Returns:
      PhysicalObject Returns a PhysicalObject
    • getChild

      public PhysicalObject getChild(String name)
      Information provided by the PKI file:
      
          \brief Returns the child with the specified name in the physical object.
          
          \param name, name of the child.
          
          \return PhysicalObject, the child with the specified name, if any.
          
              
      Specified by:
      getChild in interface PhysicalObject
      Parameters:
      name - Takes in a parameter of name
      Returns:
      PhysicalObject Returns a PhysicalObject
    • getChildByPath

      public PhysicalObject getChildByPath(String path)
      Information provided by the PKI file:
      
          \brief Returns the child recursively with the specified path separated by comma (,) in the physical object.
          
          \param path, path of the child separated by comma (,).
          
          \return PhysicalObject, the child with the specified path, if any.
          
              
      Specified by:
      getChildByPath in interface PhysicalObject
      Parameters:
      path - Takes in a parameter of path
      Returns:
      PhysicalObject Returns a PhysicalObject
    • setBackground

      public void setBackground(String path, boolean tiled)
      Information provided by the PKI file:
      
          \brief Sets the background image path to use when inside the physical object.
          
          \param path, path to the image to use.
          \param tiled, true to tile the background false to just show one image.
          
              
      Specified by:
      setBackground in interface PhysicalObject
      Parameters:
      path - Takes in a parameter of path
      tiled - Takes in a parameter of tiled
    • getBackground

      public String getBackground()
      Information provided by the PKI file:
      
          \brief Sets the background image path to use when inside the physical object.
          
          \return QString, the background image path.
          
              
      Specified by:
      getBackground in interface PhysicalObject
      Returns:
      String Returns a String
    • getEnvironment

      public Environment getEnvironment()
      Information provided by the PKI file:
      
          \brief Gets the environment for the physical object.
          
          \return Environment, the environment for the physical object.
          
              
      Specified by:
      getEnvironment in interface PhysicalObject
      Returns:
      Environment Returns a Environment
    • setX

      public void setX(int x)
      Specified by:
      setX in interface PhysicalObject
      Parameters:
      x - Takes in a parameter of x
    • setY

      public void setY(int y)
      Information provided by the PKI file:
      
          \brief Sets the y-coordinate of the component item.
          
          \param y, the y-coordinate of the component item.
          
              
      Specified by:
      setY in interface PhysicalObject
      Parameters:
      y - Takes in a parameter of y
    • moveBy

      public void moveBy(int x, int y)
      Information provided by the PKI file:
      
          \brief Moves the component item by the specified x and y values.
          
          \param x, the value to move the component item by on the x-axis.
          \param y, the value to move the component item by on the y-axis.
          
              
      Specified by:
      moveBy in interface PhysicalObject
      Parameters:
      x - Takes in a parameter of x
      y - Takes in a parameter of y
    • moveTo

      public void moveTo(int x, int y)
      Information provided by the PKI file:
      
          \brief Moves the component item to the specified coordinates.
          
          \param x, the value to move the component item to on the x-axis.
          \param y, the value to move the component item to on the y-axis.
          
              
      Specified by:
      moveTo in interface PhysicalObject
      Parameters:
      x - Takes in a parameter of x
      y - Takes in a parameter of y
    • getXScale

      public double getXScale()
      Specified by:
      getXScale in interface PhysicalObject
      Returns:
      double Returns a double
    • getYScale

      public double getYScale()
      Specified by:
      getYScale in interface PhysicalObject
      Returns:
      double Returns a double
    • getWidth

      public double getWidth()
      Specified by:
      getWidth in interface PhysicalObject
      Returns:
      double Returns a double
    • getHeight

      public double getHeight()
      Specified by:
      getHeight in interface PhysicalObject
      Returns:
      double Returns a double
    • setXVelocity

      public void setXVelocity(double xv)
      Information provided by the PKI file:
      
          \brief Sets the x-axis velocity of the component item.
          
          \param xv, the x-axis velocity of the component item.
          
              
      Specified by:
      setXVelocity in interface PhysicalObject
      Parameters:
      xv - Takes in a parameter of xv
    • setYVelocity

      public void setYVelocity(double yv)
      Information provided by the PKI file:
      
          \brief Sets the y-axis velocity of the component item.
          
          \param yv, the y-axis velocity of the component item.
          
              
      Specified by:
      setYVelocity in interface PhysicalObject
      Parameters:
      yv - Takes in a parameter of yv
    • setVelocity

      public void setVelocity(double xv, double yv)
      Information provided by the PKI file:
      
          \brief Sets the x-axis and y-axis velocity of the component item.
          
          \param xv, the x-axis velocity of the component item.
          \param yv, the y-axis velocity of the component item.
          
              
      Specified by:
      setVelocity in interface PhysicalObject
      Parameters:
      xv - Takes in a parameter of xv
      yv - Takes in a parameter of yv
    • xVelocity

      public double xVelocity()
      Information provided by the PKI file:
      
          \brief Returns the x-axis velocity of the component item.
          
          \return double, the x-axis velocity of the component item.
          
              
      Specified by:
      xVelocity in interface PhysicalObject
      Returns:
      double Returns a double
    • yVelocity

      public double yVelocity()
      Information provided by the PKI file:
      
          \brief Returns the y-axis velocity of the component item.
          
          \return double, the y-axis velocity of the component item.
          
              
      Specified by:
      yVelocity in interface PhysicalObject
      Returns:
      double Returns a double
    • getPathUuid

      public String getPathUuid()
      Information provided by the PKI file:
      
          \brief Returns the UUID of the physical object
          
          \return QString, the UUID of the physical object
          
              
      Specified by:
      getPathUuid in interface PhysicalObject
      Returns:
      String Returns a String
    • nameToUuidPath

      public String nameToUuidPath(String namePath)
      Information provided by the PKI file:
      
          \brief Returns the comma-separated UUID path of the physical object from the given comma-separated physical location name path
          
          \return QString, the comma-separated UUID path of the physical object from the given comma-separated physical location name path
          
              
      Specified by:
      nameToUuidPath in interface PhysicalObject
      Parameters:
      namePath - Takes in a parameter of namePath
      Returns:
      String Returns a String
    • uuidToNamePath

      public String uuidToNamePath(String uuidPath)
      Information provided by the PKI file:
      
          \brief Returns the comma-separated name path of the physical object from the given comma-separated physical location UUID path
          
          \return QString, the comma-separated name path of the physical object from the given comma-separated physical location UUID path
          
              
      Specified by:
      uuidToNamePath in interface PhysicalObject
      Parameters:
      uuidPath - Takes in a parameter of uuidPath
      Returns:
      String Returns a String